home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1660.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  4.8 KB  |  251 lines
  1. 164
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. WindowInfo 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows and Macintosh
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baWindowInfo returns information about a window.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baWindowInfo( WindowHandle , InfoType )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. Integer, String 
  36. --- RECORDSEPARATOR ---
  37. WindowHandle is the handle of the window. 
  38. --- RECORDSEPARATOR ---
  39. InfoType is the type of information required. Can be one of the following: 
  40. --- RECORDSEPARATOR ---
  41. "title" 
  42. --- RECORDSEPARATOR ---
  43. the caption of the window 
  44. --- RECORDSEPARATOR ---
  45. -
  46. --- RECORDSEPARATOR ---
  47.  Win, Mac
  48. --- RECORDSEPARATOR ---
  49.  
  50. --- RECORDSEPARATOR ---
  51. "class" 
  52. --- RECORDSEPARATOR ---
  53. the class name/creator type of the window 
  54. --- RECORDSEPARATOR ---
  55. -
  56. --- RECORDSEPARATOR ---
  57.  Win, Mac
  58. --- RECORDSEPARATOR ---
  59.  
  60. --- RECORDSEPARATOR ---
  61. "state" 
  62. --- RECORDSEPARATOR ---
  63. the present state of the window 
  64. --- RECORDSEPARATOR ---
  65. -
  66. --- RECORDSEPARATOR ---
  67.  Win
  68. --- RECORDSEPARATOR ---
  69. . Return can be: 
  70. --- RECORDSEPARATOR ---
  71. "hidden" 
  72. --- RECORDSEPARATOR ---
  73. the window is hidden 
  74. --- RECORDSEPARATOR ---
  75. "min" 
  76. --- RECORDSEPARATOR ---
  77. minimised 
  78. --- RECORDSEPARATOR ---
  79. "max" 
  80. --- RECORDSEPARATOR ---
  81. maximised 
  82. --- RECORDSEPARATOR ---
  83. "normal" 
  84. --- RECORDSEPARATOR ---
  85. normal state 
  86. --- RECORDSEPARATOR ---
  87. "text" 
  88. --- RECORDSEPARATOR ---
  89. the window's text -
  90. --- RECORDSEPARATOR ---
  91.  Win
  92. --- RECORDSEPARATOR ---
  93.  
  94. --- RECORDSEPARATOR ---
  95. "left" 
  96. --- RECORDSEPARATOR ---
  97. the left edge of the window in pixels 
  98. --- RECORDSEPARATOR ---
  99. -
  100. --- RECORDSEPARATOR ---
  101.  Win
  102. --- RECORDSEPARATOR ---
  103.  
  104. --- RECORDSEPARATOR ---
  105. "right" 
  106. --- RECORDSEPARATOR ---
  107. the right edge -
  108. --- RECORDSEPARATOR ---
  109.  Win
  110. --- RECORDSEPARATOR ---
  111.  
  112. --- RECORDSEPARATOR ---
  113. "top" 
  114. --- RECORDSEPARATOR ---
  115. the top edge of the window in pixels 
  116. --- RECORDSEPARATOR ---
  117. -
  118. --- RECORDSEPARATOR ---
  119.  Win
  120. --- RECORDSEPARATOR ---
  121.  
  122. --- RECORDSEPARATOR ---
  123. "bottom" 
  124. --- RECORDSEPARATOR ---
  125. the bottom edge -
  126. --- RECORDSEPARATOR ---
  127.  Win
  128. --- RECORDSEPARATOR ---
  129.  
  130. --- RECORDSEPARATOR ---
  131. "width" 
  132. --- RECORDSEPARATOR ---
  133. the width of the window 
  134. --- RECORDSEPARATOR ---
  135. -
  136. --- RECORDSEPARATOR ---
  137.  Win
  138. --- RECORDSEPARATOR ---
  139.  
  140. --- RECORDSEPARATOR ---
  141. "height" 
  142. --- RECORDSEPARATOR ---
  143. the height of the window 
  144. --- RECORDSEPARATOR ---
  145. -
  146. --- RECORDSEPARATOR ---
  147.  Win
  148. --- RECORDSEPARATOR ---
  149.  
  150. --- RECORDSEPARATOR ---
  151. "rel left" 
  152. --- RECORDSEPARATOR ---
  153. the left edge of the window in relation to itΓÇÖs parent -
  154. --- RECORDSEPARATOR ---
  155.  Win
  156. --- RECORDSEPARATOR ---
  157.  
  158. --- RECORDSEPARATOR ---
  159. "rel top" 
  160. --- RECORDSEPARATOR ---
  161. the top edge of the window in relation to itΓÇÖs parent -
  162. --- RECORDSEPARATOR ---
  163.  Win
  164. --- RECORDSEPARATOR ---
  165.  
  166. --- RECORDSEPARATOR ---
  167. "client height" 
  168. --- RECORDSEPARATOR ---
  169. the height of the client area of the window 
  170. --- RECORDSEPARATOR ---
  171. -
  172. --- RECORDSEPARATOR ---
  173.  Win
  174. --- RECORDSEPARATOR ---
  175.  
  176. --- RECORDSEPARATOR ---
  177. "client width" 
  178. --- RECORDSEPARATOR ---
  179. the width of the client area of the window 
  180. --- RECORDSEPARATOR ---
  181. -
  182. --- RECORDSEPARATOR ---
  183.  Win
  184. --- RECORDSEPARATOR ---
  185.  
  186. --- RECORDSEPARATOR ---
  187. "app" 
  188. --- RECORDSEPARATOR ---
  189. the path to the application that owns the window 
  190. --- RECORDSEPARATOR ---
  191. -
  192. --- RECORDSEPARATOR ---
  193.  Win, Mac
  194. --- RECORDSEPARATOR ---
  195.  
  196. --- RECORDSEPARATOR ---
  197. Returns:
  198. --- RECORDSEPARATOR ---
  199.  
  200. --- RECORDSEPARATOR ---
  201. String. 
  202. --- RECORDSEPARATOR ---
  203. Returns the information requested, or "Invalid" if the window doesn't exist..
  204. --- RECORDSEPARATOR ---
  205.  
  206. --- RECORDSEPARATOR ---
  207. Examples:
  208. --- RECORDSEPARATOR ---
  209.  
  210. --- RECORDSEPARATOR ---
  211. Director: 
  212. --- RECORDSEPARATOR ---
  213. set State = baWindowInfo( Window, "state" ) 
  214. --- RECORDSEPARATOR ---
  215. Authorware: 
  216. --- RECORDSEPARATOR ---
  217. State := baWindowInfo( Window, "state" )
  218. --- RECORDSEPARATOR ---
  219.  
  220. --- RECORDSEPARATOR ---
  221. Notes:
  222. --- RECORDSEPARATOR ---
  223.  
  224. --- RECORDSEPARATOR ---
  225. The "text" option can be used to retrieve the text in an edit control window. 
  226. --- RECORDSEPARATOR ---
  227. On
  228. --- RECORDSEPARATOR ---
  229.  Mac
  230. --- RECORDSEPARATOR ---
  231. , you can use ΓÇ£creatorΓÇ¥ instead of ΓÇ£classΓÇ¥. 
  232. --- RECORDSEPARATOR ---
  233. When using the "rel left" and "rel top" options, if the window is a child of another 
  234. --- RECORDSEPARATOR ---
  235. window, then the values returned will be relative to the parent window. If the 
  236. --- RECORDSEPARATOR ---
  237. window does not have a parent window, then the returns will be relative to the 
  238. --- RECORDSEPARATOR ---
  239. screen.
  240. --- RECORDSEPARATOR ---
  241.  
  242. --- RECORDSEPARATOR ---
  243. See also:
  244. --- RECORDSEPARATOR ---
  245.  
  246. --- RECORDSEPARATOR ---
  247. baSetWindowTitle 
  248. --- RECORDSEPARATOR ---
  249. baMoveWindow 
  250. --- RECORDSEPARATOR ---
  251. baSetWindowState